phosphor-keymap

phosphor-keymap

A module for cross-browser keyboard shortcut support.

API Docs

Package Install

Prerequisites

• node

npm install --save phosphor-keymap

Source Build

Prerequisites

• git
• node

git clone https://github.com/phosphorjs/phosphor-keymap.git
cd phosphor-keymap
npm install

Run Tests

Follow the source build instructions first.

npm test

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

• IE 11+
• Firefox 32+
• Chrome 38+

Bundle for the Browser

Follow the package install instructions first.

Any bundler that understands how to require() files with .js and .css extensions can be used with this package.

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simple omit the type declarations when using a language other than TypeScript.